<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>headset.util.Snake'</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="headset-module.html">Package&nbsp;headset</a> ::
        <a href="headset.util-module.html">Package&nbsp;util</a> ::
        Module&nbsp;Snake'
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="headset.util.Snake%27-module.html">Module headset.util.Snake'</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-docstring">        Snake is a publisher subscriber profiler. It records the order and counts</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring">        the number of pubsub calls.</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-docstring">        @author: J.H. Donker</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-docstring">        @copyright: Twente University</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">wx</tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">wx</tt><tt class="py-op">.</tt><tt class="py-name">lib</tt><tt class="py-op">.</tt><tt class="py-name">pubsub</tt> <tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Variable headset.Main.Publisher=headset.Main-module.html#Publisher,Variable headset.Publisher=headset-module.html#Publisher,Variable headset.gui.Publisher=headset.gui-module.html#Publisher,Variable headset.gui.VTKComponent'.Publisher=headset.gui.VTKComponent%27-module.html#Publisher,Variable headset.gui.VTKInteractor'.Publisher=headset.gui.VTKInteractor%27-module.html#Publisher,Variable headset.gui.VTKView'.Publisher=headset.gui.VTKView%27-module.html#Publisher,Variable headset.model.HeaDSETCone'.Publisher=headset.model.HeaDSETCone%27-module.html#Publisher,Variable headset.model.HeaDSETCube'.Publisher=headset.model.HeaDSETCube%27-module.html#Publisher,Variable headset.model.HeaDSETCylinder'.Publisher=headset.model.HeaDSETCylinder%27-module.html#Publisher,Variable headset.model.HeaDSETDicom'.Publisher=headset.model.HeaDSETDicom%27-module.html#Publisher,Variable headset.model.HeaDSETGeom'.Publisher=headset.model.HeaDSETGeom%27-module.html#Publisher,Variable headset.model.HeaDSETSphere'.Publisher=headset.model.HeaDSETSphere%27-module.html#Publisher,Variable headset.model.Publisher=headset.model-module.html#Publisher,Variable headset.peripherals.OutputController'.Publisher=headset.peripherals.OutputController%27-module.html#Publisher,Variable headset.peripherals.OutputInstrumentRecording'.Publisher=headset.peripherals.OutputInstrumentRecording%27-module.html#Publisher,Variable headset.peripherals.OutputJournal'.Publisher=headset.peripherals.OutputJournal%27-module.html#Publisher,Variable headset.peripherals.Publisher=headset.peripherals-module.html#Publisher,Variable headset.util.Publisher=headset.util-module.html#Publisher,Variable headset.util.Snake'.Publisher=headset.util.Snake%27-module.html#Publisher"><a title="headset.Main.Publisher
headset.Publisher
headset.gui.Publisher
headset.gui.VTKComponent'.Publisher
headset.gui.VTKInteractor'.Publisher
headset.gui.VTKView'.Publisher
headset.model.HeaDSETCone'.Publisher
headset.model.HeaDSETCube'.Publisher
headset.model.HeaDSETCylinder'.Publisher
headset.model.HeaDSETDicom'.Publisher
headset.model.HeaDSETGeom'.Publisher
headset.model.HeaDSETSphere'.Publisher
headset.model.Publisher
headset.peripherals.OutputController'.Publisher
headset.peripherals.OutputInstrumentRecording'.Publisher
headset.peripherals.OutputJournal'.Publisher
headset.peripherals.Publisher
headset.util.Publisher
headset.util.Snake'.Publisher" class="py-name" href="#" onclick="return doclink('link-0', 'Publisher', 'link-0');">Publisher</a></tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"> </tt>
<a name="Snake"></a><div id="Snake-def"><a name="L13"></a><tt class="py-lineno">13</tt> <a class="py-toggle" href="#" id="Snake-toggle" onclick="return toggle('Snake');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="headset.util.Snake'.Snake-class.html">Snake</a><tt class="py-op">:</tt> </tt>
</div><div id="Snake-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="Snake-expanded"><a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line">        <tt class="py-docstring">'''</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">                Snake listens to all calls and records everything.</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="Snake.__init__"></a><div id="Snake.__init__-def"><a name="L17"></a><tt class="py-lineno">17</tt> <a class="py-toggle" href="#" id="Snake.__init__-toggle" onclick="return toggle('Snake.__init__');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="headset.util.Snake'.Snake-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Snake.__init__-collapsed" style="display:none;" pad="++" indent="++++++++++++"></div><div id="Snake.__init__-expanded"><a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line">                <tt class="py-docstring">'''</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-docstring">                        Constructor. Subscribes to all messages.</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-docstring">                '''</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line">                <tt id="link-1" class="py-name"><a title="headset.Main.Publisher
headset.Publisher
headset.gui.Publisher
headset.gui.VTKComponent'.Publisher
headset.gui.VTKInteractor'.Publisher
headset.gui.VTKView'.Publisher
headset.model.HeaDSETCone'.Publisher
headset.model.HeaDSETCube'.Publisher
headset.model.HeaDSETCylinder'.Publisher
headset.model.HeaDSETDicom'.Publisher
headset.model.HeaDSETGeom'.Publisher
headset.model.HeaDSETSphere'.Publisher
headset.model.Publisher
headset.peripherals.OutputController'.Publisher
headset.peripherals.OutputInstrumentRecording'.Publisher
headset.peripherals.OutputJournal'.Publisher
headset.peripherals.Publisher
headset.util.Publisher
headset.util.Snake'.Publisher" class="py-name" href="#" onclick="return doclink('link-1', 'Publisher', 'link-0');">Publisher</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">subscribe</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method headset.util.Snake'.Snake.SnakeMethod()=headset.util.Snake%27.Snake-class.html#SnakeMethod"><a title="headset.util.Snake'.Snake.SnakeMethod" class="py-name" href="#" onclick="return doclink('link-2', 'SnakeMethod', 'link-2');">SnakeMethod</a></tt><tt class="py-op">)</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">topics</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">order</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line">                 </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">         </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line">                 </tt>
<a name="Snake.SnakeMethod"></a><div id="Snake.SnakeMethod-def"><a name="L27"></a><tt class="py-lineno">27</tt> <a class="py-toggle" href="#" id="Snake.SnakeMethod-toggle" onclick="return toggle('Snake.SnakeMethod');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="headset.util.Snake'.Snake-class.html#SnakeMethod">SnakeMethod</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Snake.SnakeMethod-collapsed" style="display:none;" pad="++" indent="++++++++++++"></div><div id="Snake.SnakeMethod-expanded"><a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">                <tt class="py-docstring">'''</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line"><tt class="py-docstring">                        The work horse method. Logs everything.</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line"><tt class="py-docstring">                        </tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line"><tt class="py-docstring">                        @param message: The recieved message.</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line"><tt class="py-docstring">                '''</tt> </tt>
<a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">order</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">topic</tt><tt class="py-op">)</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">topics</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">topic</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line">                        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">topics</tt><tt class="py-op">[</tt><tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">topic</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line">                        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">topics</tt><tt class="py-op">[</tt><tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">topic</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt>  <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">topics</tt><tt class="py-op">[</tt><tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">topic</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line">                <tt class="py-comment">#self.PrintStats()</tt> </tt>
<a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line"><tt class="py-comment"></tt>                 </tt>
<a name="Snake.PrintStats"></a><div id="Snake.PrintStats-def"><a name="L40"></a><tt class="py-lineno">40</tt> <a class="py-toggle" href="#" id="Snake.PrintStats-toggle" onclick="return toggle('Snake.PrintStats');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="headset.util.Snake'.Snake-class.html#PrintStats">PrintStats</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Snake.PrintStats-collapsed" style="display:none;" pad="++" indent="++++++++++++"></div><div id="Snake.PrintStats-expanded"><a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line">                <tt class="py-docstring">'''</tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line"><tt class="py-docstring">                        Print the stats that where captured.</tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line"><tt class="py-docstring">                '''</tt> </tt>
<a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">"Messages"</tt> </tt>
<a name="L45"></a><tt class="py-lineno">45</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">order</tt> </tt>
<a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">"Sats:"</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">topics</tt> </tt>
<a name="L48"></a><tt class="py-lineno">48</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">"Dc:"</tt><tt class="py-op">,</tt> <tt id="link-3" class="py-name"><a title="headset.Main.Publisher
headset.Publisher
headset.gui.Publisher
headset.gui.VTKComponent'.Publisher
headset.gui.VTKInteractor'.Publisher
headset.gui.VTKView'.Publisher
headset.model.HeaDSETCone'.Publisher
headset.model.HeaDSETCube'.Publisher
headset.model.HeaDSETCylinder'.Publisher
headset.model.HeaDSETDicom'.Publisher
headset.model.HeaDSETGeom'.Publisher
headset.model.HeaDSETSphere'.Publisher
headset.model.Publisher
headset.peripherals.OutputController'.Publisher
headset.peripherals.OutputInstrumentRecording'.Publisher
headset.peripherals.OutputJournal'.Publisher
headset.peripherals.Publisher
headset.util.Publisher
headset.util.Snake'.Publisher" class="py-name" href="#" onclick="return doclink('link-3', 'Publisher', 'link-0');">Publisher</a></tt><tt class="py-op">.</tt><tt class="py-name">getDeliveryCount</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">"Mc:"</tt><tt class="py-op">,</tt> <tt id="link-4" class="py-name"><a title="headset.Main.Publisher
headset.Publisher
headset.gui.Publisher
headset.gui.VTKComponent'.Publisher
headset.gui.VTKInteractor'.Publisher
headset.gui.VTKView'.Publisher
headset.model.HeaDSETCone'.Publisher
headset.model.HeaDSETCube'.Publisher
headset.model.HeaDSETCylinder'.Publisher
headset.model.HeaDSETDicom'.Publisher
headset.model.HeaDSETGeom'.Publisher
headset.model.HeaDSETSphere'.Publisher
headset.model.Publisher
headset.peripherals.OutputController'.Publisher
headset.peripherals.OutputInstrumentRecording'.Publisher
headset.peripherals.OutputJournal'.Publisher
headset.peripherals.Publisher
headset.util.Publisher
headset.util.Snake'.Publisher" class="py-name" href="#" onclick="return doclink('link-4', 'Publisher', 'link-0');">Publisher</a></tt><tt class="py-op">.</tt><tt class="py-name">getMessageCount</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L49"></a><tt class="py-lineno">49</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    <a href="epydoc-log.html">Generated by Epydoc
    3.0.1 on Wed Feb 25 12:58:02 2009</a>
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
